home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2000 January / Macworld (2000-01).dmg / Shareware World / Utilities / Data & Time / Troi-Serial-Plug-in2.0.sea / Troi-Serial-Plug-in2.0 / Overview.fp3 (.txt) < prev    next >
FileMaker Pro Database  |  1999-11-08  |  69KB  |  409 lines
  1.  Copyright 1984-1998 FileMaker, Inc. 
  2. HBAM2016AUG95
  3. Pro 3.0
  4. FUNCTIONINVERSION
  5. FPTHA
  6. HBAM3016AUG95@
  7. serial-close
  8. serial-control
  9. serial-datawasreceiv
  10. serial-getportnames
  11. serial-open
  12. serial-receive
  13. serial-restoresituat
  14. serial-send
  15. serial-setdispatchsc
  16. serial-toascii
  17. serial-version
  18. nknown
  19. 0an unexpected TCP/IP error (
  20. AppleTalk is not enabled ( TCP/IP couldn't be initialized (:the manually set TCP/IP address is configured improperly (Jthe TCP/IP address is already in use or an address could not be obtained (
  21. ; This file is created and used by FileMaker Pro for TCP/IP access.
  22. ; It should contain one IP address or host name per line.
  23. ; Lines starting with a semicolon are ignored.
  24. FileMaker Hosts
  25. Local Hosts
  26. Specify Host...:FileMaker host name is limited to 32 
  27. zondag
  28. maandag
  29. dinsdag
  30. woensdag
  31.     donderdag
  32. vrijdag
  33. zaterdag
  34. januari
  35. februari
  36. maart
  37. april
  38. augustus
  39.     september
  40. oktober
  41. november
  42. december
  43. 1st Quarter
  44. 2nd Quarter
  45. 3rd Quarter
  46. 4th Quarter
  47. 10/15/99
  48. FUNCTIONCATEGORY
  49. FUNCTIONDESCRIPTION
  50. FUNCTIONID
  51. Function Overview
  52. Function Details
  53. Function Details (work)
  54. Function OverviewB
  55. FUNCTIONINVERSION
  56. FUNCTIONMAC
  57. FUNCTIONNAME
  58. FUNCTIONSYNTAX
  59. FUNCTIONWIN
  60. GNUMBER
  61. gNumberB
  62. FunctionNameB
  63. FunctionMacB
  64. FunctionWinB
  65. FunctionDescriptionB
  66. FunctionSyntaxB
  67. FunctionIDB
  68. FunctionCategoryB
  69. FunctionInVersionB
  70. Function DetailsB
  71. Plug-in 
  72. Function OverviewQ
  73. To MenuW
  74. Function Overview
  75. Print`
  76. N.A. = Not Applicableb
  77. Categoryp*See also the User Manual for more details.s
  78.  1999 Troi Automatiseringt
  79. details
  80. Function Details (work)B
  81. Plug-in Function SpecsQ
  82. OverviewW
  83. FunctionZ
  84. Print`
  85. N.A. = Not Applicable
  86. Namee
  87. Parametersf
  88. Descriptiong
  89.  1997-1999 Troi Automatisering
  90. Serial-Versionf
  91. |Example usage: External(Serial-Version, "") will return "Troi Serial Plug-in 1.0".
  92. Important: always use this function to determine if the plug-in is loaded. If the plug-in is not loaded use of external functions may result in data loss, as FileMaker will return an empty field to any external function that is not loaded.
  93. Note: This function is also use to register the plug-in.
  94. nonej
  95. Serialu
  96. Serial-GetPortNamesf
  97. Troi FM Plug-in Function SpecsQ
  98. OverviewW
  99. FunctionZ
  100. Print`
  101. N.A. = Not Applicabled
  102. Namee
  103. Parametersf
  104. Descriptiong
  105. Wini!
  106.  1997, 1998, Troi Automatiseringl
  107. Categoryn
  108. Function
  109. InVersionx
  110. FunctionID
  111. Serial-Openf
  112. Opens a serial port with this name and the specified parameters.
  113. Parameters: portname: the name of the port to open, switches:     (optional) specifies the setting of the port like the speed of the port etc.
  114. Result: Returned result is an error code: 
  115. 0       no error 
  116. $$-50        paramErr      There was an error with the parameter
  117. $$-108  memFullErr      Ran out of memory
  118. $$-97      portInUse    Could not open port, the port is in use    
  119. $$-4210 portDoesnotExistErr    Port with this name is not available on this
  120.  computer
  121. $$-4211AllPortsNullErr No serial ports are available on this computer
  122. Other errors might be returned.
  123. Example usage
  124.   Set Field[gErrorCode,     External("Serial-Open",  "COM2 | baud=9600 parity=none      
  125.                data=8 stop=10 flowControl=DTRDSR  flowControl=RTSCTS ") ]
  126. will open the COM2 port with a speed of 19200 baud and the specified options.
  127. -> See also the User Manual for more details.
  128. Returns the names of all serial ports that are available on the computer.
  129. Parameters: no parameters, leave empty for future use.
  130. Result: The returned result is a list of serial ports that are available on the computer that is running FileMaker Pro. Each available port is on a different line. On a Mac a typical result will be:
  131.     Printer Port
  132.     Modem Port
  133. On Windows the result will be:
  134.     COM1
  135.     COM2
  136.     COM3
  137.     COM4
  138. Use this function to let the user of the database choose which port to open. 
  139. Store the name of the chosen port in a global field. You can then check the next time the database is opened whether the portname is still present and ask the user if he wants to change his preference. 
  140. If an error occurs an error code is returned. Returned error codes can be: 
  141.     $$-108      memFullErr      Ran out of memory
  142. Other errors might be returned.
  143. -> See also the User Manual for more details.
  144. none, leave blankj
  145. Serialu
  146. portname | switchesj
  147. Serialu
  148. Serial-Closef
  149. Closes a serial port with the specified name . If the portname parameter is "" ALL ports are closed.
  150. Parameter: portname: the name of the port to close
  151. Result The returned result is an error code: 
  152. 0         no error         the port was closed
  153. $$-4210       portDoesnotExistErr    port is not available on this computer
  154. $$-4211    AllPortsNullErr        No serial ports are available on this computer
  155. $$-108      memFullErr          Ran out of memory
  156. Other errors might be returned.
  157. Example Usage 
  158. This will close the COM3 poB
  159.     Set Field[ gErrorCode, External("Serial-Close" , "COM3") ]
  160. This will close all open ports:
  161.     Set Field[ gErrorCode, External("Serial-Close" , "") ]
  162. portnamej
  163. Serialu
  164. Serial-Receivef
  165. Serial-Sendf
  166. Sends data to the serial port with the specified name . The port needs to be opened first (See also Serial-Open).
  167. Parameters portname: the name of the port to send data to, data: the text data that is to be sent to the serial port.
  168. Result The returned result is an error code. An error always starts with 2 dollars, followed by the error code. You should always check for errors when sending by testing if the first two characters are dollars.  Returned error codes can be:
  169. 0       no error    the 
  170. Receives data from a serial port with the specified name . The port needs to be opened first (See Serial-Open). If no data is available an empty string is returned:"".
  171. Parameter: portname: the name of the port to receive data from
  172. Result The returned result is the data received or an error code. An error always starts with 2 dollars, followed by the error code. You should always check for errors when receiving by testing if the first two characters are dollars. 
  173. Returned error codes can
  174. $$-28       notOpenErr    The port is not open
  175. $$-108   memFullErr      Ran out of memory
  176. $$-50         paramErr      There was an error with the parameter
  177. $$-4210 portDoesnotExistErr Port with this name is not available on this computer
  178. $$-4211 allPortsNullErr   No serial ports are available on this computer
  179. $$-207       notEnoughBufferSpace    The input buffer is full
  180. Other errors might be returned.
  181. Example Usage Set Field[ gResult, External("Serial-Receive" , "Modem port") ]
  182. This will receive data 
  183. (CCfrom the Modem port.
  184. -> See also the User Manual for more details.
  185. portnamej
  186. Serialu
  187. Serial-SetDispatchScriptf
  188. Sets the Dispatch Script to trigger when data is received. If you give an empty parameter "", the Dispatch Script is removed.
  189. Parameters: filename:  the name of the file with the Dispatch Script,  scriptID: this indicates the script to be triggered. waitforstring: (optional) wait for this string of characters before triggering a script.
  190. scriptID can be either scriptkey=x or scriptname=....
  191.   scriptkey=x : the key number in the menu of the Dispatch Script. x  must be in the range from
  192. data was send
  193. $$-28       notOpenErr    The port is not open
  194. $$-108   memFullErr      Ran out of memory
  195. $$-50         paramErr      There was an error with the parameter
  196. $$-4210 portDoesnotExist  A port with this name is not available on this computer
  197. $$-4211 AllPortsNullErr    No serial ports are available on this computer
  198. $$-207       notEnoughSpace    The output buffer is full
  199. Other errors might be returned.
  200. Example Usage 
  201. Set Field[ gResult, External("Serial-Send" ,  "Modem port| So long") ]
  202. This will CZsend the string "So long" to the Modem port.
  203. -> See also the User Manual for more details.
  204. portname  | dataj
  205. Serialu
  206. Serial-DataWasReceivedf
  207. Returns 1 when data was received on a serial port. Use this function to see if this is an event that needs to be handled.
  208. Parameters: no parameters    leave empty for future use.
  209. Result  The returned result is an boolean value. Returned is either:
  210.     0        no data received
  211.     1        data was received in the buffer
  212. When this function returns 1 you can get the data with the function Serial-Receive.
  213. Example Usage 
  214.     If[ External("Serial-DataWasReceived",  "") ]
  215.         Perform Script [Sub-scripts, 
  216. Process DaBzta Received
  217.     Else
  218.         ... do something else
  219.     Endif
  220. -> See also the User Manual under Dispatch Scripting for more details.
  221. none, leave blankj
  222. Serialu
  223. Serial-RestoreSituationf
  224. 0-9. 
  225.   scriptname=name: the name of the script to trigger.  Not available for FileMaker 4. under Windows.
  226. Result: The returned result is an error code. An error always starts with 2 dollars, followed by the error code. You should always check for errors. Returned error codes can be:
  227.     0    no error    the Dispatch Script was set
  228.     $$-50      paramErr      There was an error with the parameter
  229. Other errors might be returned.
  230. Example Usage 
  231.     Set Field[ gErrorCode, External("Serial-SetDispatchScript",  
  232.                             Status(CurrentFileName) & "| scriptname=Read Script | waitforstring=OK") ]
  233. This will set the Dispatch Script to the script 
  234. Read Script
  235.  of the current file. The script will not be triggered before the string 
  236.  is found.
  237. -> See also the User Manual under Dispatch Scripting for more details.
  238. i#filename | scriptID | waitforstringj
  239. Serialu
  240. Serial-ToASCIIf
  241. Converts (one or more) numbers to their equivalent ASCII characters. 
  242. Parameters: ASCIInumber one or more numbers in the range from 0-255
  243. Result The ASCII text
  244. Example Usage 
  245.     Set Field [text, External("Serial-ToASCII", "65|65|80|13") ]
  246. This will result in the text "AAP<CR>" where <CR> is a Carriage Return character
  247. NOTE You can also use hexadecimal notation for the numbers. Use 0x00 to 0xFF to indicate hexadecimal notation. 
  248. Example Usage 
  249.     Set Field [text, External("Serial-ToASCIB
  250. I", "0x31|0x32|0x33|0x0D|0x0A") ]
  251. This will result in the text "123<CR><LF>" where <CR> is a Carriage Return character and <LF> is a Line Feed character
  252. Bring the database file that was in front, before the Dispatch Script was called, back to the front.
  253. Parameters: no parameters leave empty for future use.
  254. Result The returned result is an error code:
  255.     0     no error
  256. At the moment no other results are returned.
  257. Example Usage 
  258.     Set Field [gErrorCode, External("Serial-RestoreSituation", "") ]
  259. -> See also the User Manual under Dispatch Scripting for more details.
  260. none, leave blankj
  261. Serialu
  262.     Open file
  263. Set all globals
  264. To Menu
  265. To Overview
  266. ----- General ------
  267. Check plug-in
  268. ----- Documentation etc ------
  269. Print Function Specs
  270. Copy Parameters
  271. Print this record
  272. BeepBeep
  273. To Menu
  274. Check plug-in
  275. Ci0ASCIInumber1 | ASCIInumber2 | ASCIInumber3 |....j
  276. Serialu
  277. Serial-Controlf
  278. Controls the serial port with the specified name . The port needs to be opened first (See also Serial-Open).
  279. Parameters: portname: the name of the port to control, switch: the action that needs to be done. This can be either:
  280. suspend    This will suspend reading the incoming stream of data.
  281. resume           This will resume reading the incoming stream of data. 
  282. Note: the buffer will be emptied when the port is suspended. So when you resume only the data received after you resume will be av
  283. ailable.
  284. Result The returned result is an error code. An error always starts with 2 dollars, followed by the error code. You should always check for errors when sending by testing if the first two characters are dollars.  Returned error codes can be:
  285. 0       no error    the data was send
  286. $$-28       notOpenErr    The port is not open
  287. $$-50         paramErr      There was an error with the parameter
  288. Other errors might be returned.
  289. Example Usage 
  290. Set Field[ gResult, External("Serial-Control" ,  "COM1| suspeC4nd") ]
  291. This will suspend the incoming stream of data
  292. portname  | switchj
  293. Serialu
  294. Set all globals
  295. ) = 1 
  296.  A    Open file
  297.     A4Important: ALWAYS check if the plug-in is available!B)Check if this is FileMaker 4.0 or higher.CQ
  298.  1)) < 4    
  299. Canceld
  300. This file requires FileMaker 4.0 or higherE*Check if the Troi FM Plug-in is available.Fz
  301. |("Troi-Version"
  302.  "") 
  303.  15 ) <> "Troi FM Plug-in"
  304. Troi-Version
  305. Troi FM Plug-in
  306. ) = 1    
  307. Canceld
  308. Troi FM Plug-in not found. Please put the Troi FM Plug-in into the Extensions folder inside the FileMaker folder. 
  309. Also enable all the plug-ins under the application preferences.
  310. Canceld
  311. Troi FM Plug-in not found. Please put the Troi FM Plug-in into the SYSTEM directory inside the FileMaker directory. 
  312. Also enable all the plug-ins under the application preferences.
  313. Print Function Specs
  314. ) < 601    
  315. Copy Parameters
  316. Cancel
  317. Do you want to copy the parameters?B+
  318. ) = 1    
  319. ----- General ------
  320. ----- Documentation etc ------
  321. Print this record
  322. BeepBeep
  323. To Overview
  324. ) = 2    
  325.     Helvetica
  326. Geneva
  327. Arial
  328. Times New Roman
  329. Monaco
  330. Courier
  331. Times
  332. Futura
  333. Courier New
  334. Palatino
  335. ) = 2    
  336. k{k|w
  337. [=g\gYg\.T
  338. g\c[_]c\ozc\g\[]g\c[o{c[g\[\g\24
  339. OYBw*
  340. _ZkZ[ZkZ_ZkZOZkZ[ZkZ_Zw
  341. k]k]{
  342. g\g=5
  343. 5sF6g]F
  344. o|g]k}
  345. GRPTH
  346. FPTHAGWORF:Projecten:Troi FM Plug-In:Troi-Text-Plug-in1.0b1:Text Examples.fp3
  347. Text Examples.fp3
  348. FMP3FMP3
  349. Troi-Text-Plug-in1.0b1
  350. GWORF:Projecten:Troi FM Plug-In:Troi-Text-Plug-in1.0b1:Text Examples.fp3
  351. MSPCA
  352. NAMEA
  353. Text Examples.fp3
  354. RPTHA
  355. Text Examples.fp3
  356. ZONEA
  357.     192.1.1.2
  358. Text Examples.fp3
  359. FMP3FMP3
  360. Troi-Text-Plug-in1.0b1
  361. GWORF:Projecten:Troi FM Plug-In:Troi-Text-Plug-in1.0b1:Text Examples.fp3
  362. \RPTH
  363.     k]k]s
  364. o|g]{
  365. k]k]w
  366. Nv_:5
  367. g=g<_;w
  368. o\o}5
  369. k=JW1
  370. o\g{1
  371. g=k]5
  372. NvkZ2
  373. s}g]k\
  374. g=g<w
  375. g}k=o
  376. o^k{k}
  377. g]k=k
  378. g}k]o}
  379. (LIST
  380. LISTA    Full Path
  381. VDEFA(
  382. (LIST
  383. LISTA
  384. VDEFA(
  385. (LIST
  386. VDEFA(
  387. (LIST
  388. VDEFA(
  389. (LIST
  390. VDEFA(
  391. A    Full PathB
  392. BooleanC
  393. TEST Cond value (does not work)D
  394. CategoriesE TEST Cond value2 (does not work)
  395. FPTHA\KES:Projecten:Troi Plug-In 981215:Troi Plug-ins:SERIAL:Troi-Serial-Plug-in1.0b1:SeriExpl.fp3
  396. MSPCA
  397. NAMEA
  398. SeriExpl.fp3
  399. RPTHA
  400. SeriExpl.fp3
  401. SeriExpl.fp3
  402. FMP3FMP3
  403. Troi-Serial-Plug-in1.0b1
  404. \KES:Projecten:Troi Plug-In 981215:Troi Plug-ins:SERIAL:Troi-Serial-Plug-in1.0b1:SeriExpl.fp3
  405. McGee
  406. peter
  407. Pro 3.0 - 4.0F!
  408. Pro 3.0 - 4.0M1
  409.